Each topic can have files attached to it, similar to an email attachment. Use your browser to upload or download a file.
Attachments are stored under revision control, so uploads can never be lost, and files changes can be made with a rollback option that lets you retrieve all previous versions.
You can use Attachments to store and retrieve documents (in any format, with associated graphics, and other media files); attach documents to specific TWiki topics; collaborate on documents with full revision control; distribute documents on a need-to-know basis using; create a central reference library that's easy to access and manage by an entire user group.
For file sharing, FileAttachments on a series of topics can be used to quickly create a well-documented, categorized digital download center for all types of files: documents; graphics and other media; drivers and patches; applications; anything you can safely upload!
Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to embed on a page) and place them anywhere in on a single page, or for use across a web, or site-wide.
NOTE: You can also add graphics - any files - directly, typically by FTP upload. This requires server access, and may be more convenient if a large number of files, or a particular directory location, is required. These files can't be managed using browser-based Attachment controls.
To upload: Click on the Attach link at the bottom of each page. A form is shown where you can browse for a file and upload it. The uploaded file will show up in the File Attachment table.
Files of any type can be uploaded. Some files that might impose a security risk are renamed, ex: *.php files are renamed to *.php.txt.
Currently there is no file size limit besides the disk space on the server.
The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field.
NOTE: There is no access control on individual attachments. If you need this type of control, create separate topics and define access restrictions? per topic.
An attachement can be moved between topics. To do this click Action on the attachment to be moved. On the control page, select the new web and topic, the click Move. The attachment and its version history are moved. The original location is stored as topic Meta Data?.
It is not possible to delete attached files with the current TWiki implementation. However, they can be moved to another topic. You may care to have a topic Trash.TrashAttachments - move attachments that are no longer wanted here.
Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click Attach.
Clicking on an Action link takes you to a new page that looks like this:
The first table is a list of all attachments, including their attributes. An h means the attachment is hidden, it isn't listed when viewing a topic.
The second table is all the versions of the attachment. Click on View to see that version. If it's the most recent version, you'll be taken to an URL that always displays the latest version, which is usually what you want.
To change the comment on an attachment, enter a new comment and then click Change properties. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change.
To hide/unhide an attachment, enable the Hide file checkbox, then click Change properties.
Unlike topics, attachments are not locked during editing. As a workaround, you can change the comment to indicate an attachment file is being worked on - the comment on the specific version isn't lost, it's there when you list all versions of the attachment.
(Note: Set the members of TWiki Administrator Group in GROUP, then enable the ALLOWTOPICCHANGE variable by removing # sign)
Related topics:TWikiUsers, TWikiGroups, TWikiAccessControl
Add your groups to this list and define new group topics similar to existing ones. Group topics must end in ...Group.IMPORTANT NOTE: Think twice before restricting write access to a web or a topic, because an open system where everybody can contribute is the essence of the WikiCulture. Experience shows that unrestricted write access works very well because:
There is enough peer pressure to post only conform content.
Content does not get lost because topics are under revision control.
A topic revision can be undone by a member of the TWikiAdminGroup in case needed.
A guest of this TWiki web, not unlike yourself. You can leave your trace behind you, just add your name in TWikiRegistration and create your own page.
Personal Preferences (details in TWikiVariables)
Horizontal size of text edit box:
Set EDITBOXWIDTH = 70
Vertical size of text edit box:
Set EDITBOXHEIGHT = 17
Default state of the link check box in the attach file page:
List of TWiki users
Please take the time and add yourself to the list. To do that fill out the form in TWikiRegistration. This will create an account for you which allows you to edit topics.
ABCDEFGHIJKLMNOPQRSTUVWXYZ
TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.
Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.
TWiki expands the following variables (enclosed in % percent signs):
Variable:
Expanded to:
%WIKIHOMEURL%
The base script URL of TWiki, is the link of the Home icon in the upper left corner, is http://robert.freeshell.org/twiki
%SCRIPTURL%
The script URL of TWiki, is http://robert.freeshell.org/twiki/bin
%SCRIPTURLPATH%
The path of the script URL of TWiki, is /twiki/bin
%SCRIPTSUFFIX%
The script suffix, ex: .pl, .cgi is
%PUBURL%
The public URL of TWiki, is http://robert.freeshell.org/twiki/pub
%PUBURLPATH%
The path of the public URL of TWiki, is /twiki/pub
%ATTACHURL%
The attachment URL of the current topic, is http://robert.freeshell.org/twiki/pub/TWiki/TWikiVariables Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%ATTACHURLPATH%
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%URLPARAM{"name"}%
Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%WIKITOOLNAME%
Name of wiki tool, is TWiki
%WIKIVERSION%
Wiki tool version is 01 Dec 2001
%USERNAME%
Your login username is guest
%WIKINAME%
Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
%WIKIUSERNAME%
Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
The index topic of all registered users. Is TWikiUsers
%WIKIPREFSTOPIC%
The web preferences topic. Is TWikiPreferences
%WEBPREFSTOPIC%
The web preferences topic. Is WebPreferences
%STATISTICSTOPIC%
The web statistics topic. Is WebStatistics
%TOPIC%
The current topic name, is TWikiVariables
%BASETOPIC%
The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
%INCLUDINGTOPIC%
The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
%SPACEDTOPIC%
The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
%TOPICLIST{"format"}%
Topic index of a web. The "format" defines the format of one topic item. It may include variables: The $name variable gets expanded to the topic name; the $web variable gets expanded to the name of the web.
Parameters are format, separator and web:
Parameter:
Description:
Default:
"format"
Format of one line, may include $name and $web variables
"$name"
format="format"
(Alternative to above)
"$name"
separator=", "
line separator
"\n" (new line)
web="Name"
Name of web
Current web
Examples:
%TOPICLIST{" * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
Parameters are format, separator and web:
Parameter:
Description:
Default:
"format"
Format of one line, may include $name variable
"$name"
format="format"
(Alternative to above)
"$name"
separator=", "
line separator
"\n" (new line)
webs="public"
comma sep list of Web, public expands to all non-hidden
"public"
marker="selected"
Text for $marker where item matches selection, otherwise equals ""
"selected"
selection="%WEB%"
Current value to be selected in list
section="%WEB%"
Examples: %WEBLIST{" * [[$name.WebHome]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
%GMTIME%
GM time, is Mon Nov 23 09:37:23 2009
%GMTIME{"format"}%
Formatted GM time based on time variables.
Variable:
Unit:
Example
$seconds
seconds
59
$minutes
minutes
59
$hours
hours
23
$day
day of month
31
$month
month in ISO format
Dec
$mo
2 digit month
12
$year
4 digit year
1999
$ye
2 digit year
99
Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 23 Nov, 2009 - 09:37:23
%SERVERTIME%
Server time, is Mon Nov 23 09:37:23 2009
%SERVERTIME{"format"}%
Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 09:37
%HTTP_HOST%
HTTP_HOST environment variable, is robert.freeshell.org
%REMOTE_ADDR%
REMOTE_ADDR environment variable, is 38.107.191.111
%REMOTE_PORT%
REMOTE_PORT environment variable, is 50247
%REMOTE_USER%
REMOTE_USER environment variable, is
%INCLUDE{"page" ...}%
Server side include to IncludeTopicsAndWebPages?. Parameters are page name, and an optional pattern="(reg-exp)". The page name is:
"SomeTopic"
The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
"Web.Topic"
A topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
"http://..."
A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
%STARTINCLUDE%
If present in included topic, start to include text from this location up to the end, or up to the location of the %STOPINCLUDE% variable. A normal view of the topic shows everyting exept the %STARTINCLUDE% variable itself.
%STOPINCLUDE%
If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.
%TOC%
Table of Contents of current topic.
%TOC{"SomeTopic" ...}%
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax? ("---++ text") and HTML ("<h2>text<h2>") are taken into account. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searcing for topics that have a specific parent i.e. its children
required
web="%WEB%"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs.
required
topic="%TOPIC%"
The topic the search relates to
required
title="Title"
Text the is pre-pended to any search results
required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate? and WebTopicNonWikiTemplate? %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
%VAR{"NAME" web="Web"}%
Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
[1] Note: The search form uses identical names for input fields.
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Variable:
Level:
What:
%WIKIWEBMASTER%
SL
Webmaster email address (sender of email notifications) , is robert@freeshell.org
%WIKIWEBLIST%
SL
List of TWiki webs (in upper right corner of topics)
%WEBTOPICLIST%
WL
Common links of web (second line of topics)
%WEBCOPYRIGHT%
SL , WL
Copyright notice (bottom right corner of topics)
%WEBBGCOLOR%
WL
Background color of web
%NOSEARCHALL%
WL
Exclude web from a web="all" search (set variable to on for hidden webs)
%NEWTOPICBGCOLOR%
SL , UL
Background color of non existing topic. ( UL needs authentication for topic views )
%NEWTOPICFONTCOLOR%
SL , UL
Font color of non existing topic. ( UL needs authentication for topic views )
%EDITBOXWIDTH%
SL , UL
Horizontal size of edit box, is 70
%EDITBOXHEIGHT%
SL , UL
Vertical size of edit box, is 17
%RELEASEEDITLOCKCHECKBOX%
SL , UL
Default state of the "Release edit lock" (UnlockTopic?) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is:
%DONTNOTIFYCHECKBOX%
SL , UL
Default state of the "Minor Changes, Don't Notify" (DontNotify?) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:
%ATTACHLINKBOX%
SL , UL
Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
%HTTP_EQUIV_ON_VIEW%
SL
http-equiv meta tags for view, rdiff, attach, search* scripts.
%HTTP_EQUIV_ON_EDIT%
SL , UL
http-equiv meta tags for edit script.
%HTTP_EQUIV_ON_PREVIEW%
SL , UL
http-equiv meta tags for preview script.
%DENYWEBCHANGE%
WL
List of users and groups who are not allowed to change topics in the TWiki web. (More in TWikiAccessControl?)
%ALLOWWEBCHANGE%
WL
List of users and groups who are allowed to change topics in the TWiki web. (More in TWikiAccessControl?)
%DENYTOPICCHANGE%
(any topic)
List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl?)
%ALLOWTOPICCHANGE%
(any topic)
List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl?)
%DENYWEBRENAME%
WL
List of users and groups who are not allowed to rename topics in the TWiki web. (More in TWikiAccessControl?)
%ALLOWWEBRENAME%
WL
List of users and groups who are allowed to rename topics in the TWiki web. (More in TWikiAccessControl?)
%DENYTOPICRENAME%
(any topic)
List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl?)
%ALLOWTOPICRENAME%
(any topic)
List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl?)
%FINALPREFERENCES%
SL , WL
List of preferences that are not allowed to be overridden by next level preferences
The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value] Example:
You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
Example: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
Statistics for TWiki.Main Web Month: Topic views: Topic saves: File uploads: Most popular topic views: Top contributors for topic save and uploads: Jul 2009 151 0 ...
Name: azwar habibie Email: setan sarik@yahoo.com Company URL: Comment: thank`s Personal Preferences (details in TWIKIWEB .TWikiVariables) Horizontal size of text ...
List of TWiki users Please take the time and add yourself to the list. To do that fill out the form in TWIKIWEB .TWikiRegistration. This will create an account for ...
Name: azwar habibiee Email: banjarmasin Company URL: Comment: thank`s Personal Preferences (details in TWIKIWEB .TWikiVariables) Horizontal size of text edit box ...
TWiki.Main Web Preferences The following settings are web preferences of the TWiki.Main web. These preferences overwrite the site-level preferences in TWIKIWEB . ...
TWiki Administrator Group Set GROUP RobertWilliams Set ALLOWTOPICCHANGE TWikiAdminGroup (Note: Set the members of TWiki Administrator Group in GROUP, then enable ...
Name: Robert Williams Email: robert0122@yahoo.com URL: http://robert.freeshell.org Comment: No comment Personal Preferences (details in TWIKIWEB .TWikiVariables) ...
TWIKIWEB .WelcomeGuest: TWiki is a web-based collaboration tool, web authoring tool, document management tool and knowledge base tool. You can edit any TWiki page ...
Name: Peter Thoeny, author of the TWIKIWEB .TWikiWeb (and therefore a TWIKIWEB .TWikiContributor) Work: Peter.Thoeny@WindRiver.com Home: Peter@Thoeny.com Location ...
Name: Mike Mannix Email: mike@gearcore.com Company Name: AIR / AIRservices Country: USA TWiki Comments: xtreme fan Personal Preferences (details in TWIKIWEB .TWikiVariables ...
Nobody Group Set GROUP Set ALLOWTOPICCHANGE TWikiAdminGroup Used to prevent dangerous actions e.g. renaming TWIKIWEB .TWikiPreferences. Related topics: WIKIUSERSTOPIC ...
NOTIFYTOPIC is a subscription service to be automatically notified by email when topics change in the TWiki.Main web. This is a convenient service, so you do not ...
These groups can be used to define fine grained TWIKIWEB .TWikiAccessControl in TWiki: TWikiAdminGroup EngineeringGroup SupportGroup Add your groups to this list and ...
A guest of this TWiki web, not unlike yourself. You can leave your trace behind you, just add your name in TWIKIWEB .TWikiRegistration and create your own page. Personal ...
Name: Kevin Kinnell Email: kejoki@netdoor.com Company Name: Company URL: Country: USA Comment: Kevin is a TWIKIWEB .TWikiContributor and a core team member. Personal ...
WelcomeGuest: TWiki is a web-based collaboration tool, web authoring tool, document management tool and knowledge base tool. You can edit any TWiki page.
You can use color coding by web for identification and reference. Contact robert@freeshell.org if you need a separate collaboration web for your team. New TWiki webs can be added easily. To modify this table: { View | Edit }
Name: azwar habibie Email: setan sarik@yahoo.com Company URL: Comment: thank`s Personal Preferences (details in TWIKIWEB .TWikiVariables) Horizontal size of text ...
Name: azwar habibiee Email: banjarmasin Company URL: Comment: thank`s Personal Preferences (details in TWIKIWEB .TWikiVariables) Horizontal size of text edit box ...
Name: Kevin Kinnell Email: kejoki@netdoor.com Company Name: Company URL: Country: USA Comment: Kevin is a TWIKIWEB .TWikiContributor and a core team member. Personal ...
Name: Mike Mannix Email: mike@gearcore.com Company Name: AIR / AIRservices Country: USA TWiki Comments: xtreme fan Personal Preferences (details in TWIKIWEB .TWikiVariables ...
Nobody Group Set GROUP Set ALLOWTOPICCHANGE TWikiAdminGroup Used to prevent dangerous actions e.g. renaming TWIKIWEB .TWikiPreferences. Related topics: WIKIUSERSTOPIC ...
Name: Peter Thoeny, author of the TWIKIWEB .TWikiWeb (and therefore a TWIKIWEB .TWikiContributor) Work: Peter.Thoeny@WindRiver.com Home: Peter@Thoeny.com Location ...
Name: Robert Williams Email: robert0122@yahoo.com URL: http://robert.freeshell.org Comment: No comment Personal Preferences (details in TWIKIWEB .TWikiVariables) ...
TWiki Administrator Group Set GROUP RobertWilliams Set ALLOWTOPICCHANGE TWikiAdminGroup (Note: Set the members of TWiki Administrator Group in GROUP, then enable ...
These groups can be used to define fine grained TWIKIWEB .TWikiAccessControl in TWiki: TWikiAdminGroup EngineeringGroup SupportGroup Add your groups to this list and ...
A guest of this TWiki web, not unlike yourself. You can leave your trace behind you, just add your name in TWIKIWEB .TWikiRegistration and create your own page. Personal ...
List of TWiki users Please take the time and add yourself to the list. To do that fill out the form in TWIKIWEB .TWikiRegistration. This will create an account for ...
TWIKIWEB .WelcomeGuest: TWiki is a web-based collaboration tool, web authoring tool, document management tool and knowledge base tool. You can edit any TWiki page ...
NOTIFYTOPIC is a subscription service to be automatically notified by email when topics change in the TWiki.Main web. This is a convenient service, so you do not ...
TWiki.Main Web Preferences The following settings are web preferences of the TWiki.Main web. These preferences overwrite the site-level preferences in TWIKIWEB . ...
Statistics for TWiki.Main Web Month: Topic views: Topic saves: File uploads: Most popular topic views: Top contributors for topic save and uploads: Jul 2009 151 0 ...
WebNotify is a subscription service to be automatically notified by email when topics change in the TWiki.Main web. This is a convenient service, so you do not have to come back and check all the time if something has changed. To subscribe to the service, please put yourself on the list below. The format is: 3 spaces * Main.yourWikiName - yourEmailAddress
Note: It is helpful to insert your name in alphabetical order (by first name -- ignore the "Main.") -- then you can find your name (or not) more easily if you wish to remove it or confirm that you are on the list.
Related topics: TWikiUsers, TWikiRegistration
The following settings are web preferences of the TWiki.Main web. These preferences overwrite the site-level preferences in TWikiPreferences, and can be overwritten by user preferences (your personal topic, i.e. TWikiGuest in the TWiki.Main web)
Preferences:
Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl)
Set DENYWEBVIEW =
Set ALLOWWEBVIEW =
Set DENYWEBCHANGE =
Set ALLOWWEBCHANGE =
Set DENYWEBRENAME =
Set ALLOWWEBRENAME =
Users or groups allowed to change or rename this WebPreferences topic: (I.e. TWikiAdminGroup)
Set ALLOWTOPICCHANGE =
Set ALLOWTOPICRENAME =
Web preferences that are not allowed to be overridden by user preferences:
Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
Notes:
A preference is defined as: 6 spaces * Set NAME = value Example:
Set WEBBGCOLOR = #FFFFC0
Preferences are used as TWikiVariables by enclosing the name in percent signs. Example:
When you write variable %WEBBGCOLOR% , it gets expanded to #FFFFC0 .
The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set WEBCOPYRIGHT before WIKIWEBMASTER since %WEBCOPYRIGHT% uses the %WIKIWEBMASTER% variable.
You can introduce new preferences variables and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
, an image.
Sample.txt
Smile.gif
